Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes #17848
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @ushasan Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
ushasan
changed the base branch from
main
to
dev-Sentinel-2022-01-01-preview
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The operation 'Watchlists_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L129 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L618 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeleted Location: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L548 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeleted Location: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L649 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 1 Errors, 2 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-01-01-preview/Watchlists.json compared with base:stable/2021-10-01/Watchlists.json
- current:preview/2022-01-01-preview/Watchlists.json compared with base:preview/2021-10-01-preview/Watchlists.json
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L161:11 |
The following breaking changes are detected by comparison with latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L161:11 |
|
| The new version is missing a property found in the old version. Was 'watchlistItemsCount' renamed or removed? New: Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#L487:7 Old: Microsoft.SecurityInsights/preview/2021-10-01-preview/Watchlists.json#L463:7 |
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @ushasan, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 14, 2022
This was referenced Feb 14, 2022
This reverts commit a30a709. Reverting by 1 commit
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @ushasan |
ushasan
changed the title
|
Hi @qiaozha , please confirm breaking change of JS. |
qiaozha
reviewed
Mar 1, 2022
| @@ -4,7 +4,8 @@ | |||
| "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", | |||
| "resourceGroupName": "myRg", | |||
| "workspaceName": "myWorkspace", | |||
| "watchlistAlias": "highValueAsset", | |||
| "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", | |||
There was a problem hiding this comment.
Just out of curious, I wonder why do we need to provide this operationalInsightsResourceProvider parameter value in the example? I don't see the definition in the Watchlists.json
|
Have gotten ARM signoff: |
|
breaking changes are expected: |
msyyc
approved these changes
Mar 2, 2022
anat-gilenson
added a commit
to anat-gilenson/azure-rest-api-specs
that referenced
this pull request
Mar 2, 2022
…chlists.json 2022-01-01-preview parameter name changes (Azure#17848)" This reverts commit c206825.
dw511214992
pushed a commit
that referenced
this pull request
Mar 7, 2022
* Adds base for updating Microsoft.SecurityInsights from version preview/2021-10-01-preview to version 2022-01-01-preview * Updates readme * Updates API version in new specs and examples * SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model (#17849) * SourceControl 2022-01-01-preview version change * fix validation error * prettified * prettified Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> * New metadata API (#17942) * metadata changes * addressed changes * updated enum kind * updated values as well Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> * added new enum to kind (#17994) Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> * Add flag to rotate webhook secret (#17989) Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> * Align definitions with stable version (#17931) * Align definitions with stable version * align scheduled rule and template properties with stable * Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes (#17848) * changed source to sourceType and watchlistAlias to alias * Update CreateWatchlistAndWatchlistItems.json * Update CreateWatchlistItem.json * Update DeleteWatchlist.json * Update DeleteWatchlistItem.json * Update GetWatchlistByAlias.json * Update GetWatchlistItemById.json * Update GetWatchlistItems.json * Update GetWatchlistByAlias.json * added missing params to match stable version * Revert "added missing params to match stable version" This reverts commit a30a709. Reverting by 1 commit * refreshing pipeline * reverting lint diff change * attempting to fix RemovedPath breaking changes * Revert "attempting to fix RemovedPath breaking changes" This reverts commit 2f96ee3. reverting attempt at correcting breaking changes. cannot match preview to stable without breaking everything. * adding back source type for backwards compatibility, added response descriptions, corrected PR comments * adding missing bracket * ran npm run prettier-fix to correct style issues * resolving model/definition errors * Revert "resolving model/definition errors" This reverts commit fd67a4f. Reverting prettier changes made to other branches * Revert "ran npm run prettier-fix to correct style issues" This reverts commit 3055791. * update * Update DeleteWatchlist.json * Update Watchlists.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * fixing styling issues on Delete example * Update DeleteWatchlist.json * Update DeleteWatchlist.json * ran npm run prettier on DeleteWatchlist.json * Update Watchlists.json * reverting alias to watchlistAlias Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> * Rename system to AutoAssigned (#18061) * Rename system to AutoAssigned * Add example to list operations * Update API version in NRT examples * Execute validation tools and fix results (#17733) * Execute validation tools and fic results * Prettyfieir GetIoTById.json * Watchlists.json-2022-01-01-preview-parameterNameChanges (reverted PR reference for files changed -> https://github.com/Azure/azure-rest-api-specs/pull/17848/files) (#18085) * changed source to sourceType and watchlistAlias to alias * Update CreateWatchlistAndWatchlistItems.json * Update CreateWatchlistItem.json * Update DeleteWatchlist.json * Update DeleteWatchlistItem.json * Update GetWatchlistByAlias.json * Update GetWatchlistItemById.json * Update GetWatchlistItems.json * Update GetWatchlistByAlias.json * added missing params to match stable version * Revert "added missing params to match stable version" This reverts commit a30a709. Reverting by 1 commit * refreshing pipeline * reverting lint diff change * attempting to fix RemovedPath breaking changes * Revert "attempting to fix RemovedPath breaking changes" This reverts commit 2f96ee3. reverting attempt at correcting breaking changes. cannot match preview to stable without breaking everything. * adding back source type for backwards compatibility, added response descriptions, corrected PR comments * adding missing bracket * ran npm run prettier-fix to correct style issues * resolving model/definition errors * Revert "resolving model/definition errors" This reverts commit fd67a4f. Reverting prettier changes made to other branches * Revert "ran npm run prettier-fix to correct style issues" This reverts commit 3055791. * update * Update DeleteWatchlist.json * Update Watchlists.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * fixing styling issues on Delete example * Update DeleteWatchlist.json * Update DeleteWatchlist.json * ran npm run prettier on DeleteWatchlist.json * Update Watchlists.json * reverting alias to watchlistAlias * fixing type version * Update Watchlists.json * Update DeleteWatchlist.json * fixing commas Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> Co-authored-by: Usman Hasan <usman.hasan@microsoft.com> * Done (#17843) Co-authored-by: Roy Reinhorn <roreinho@microsoft.com> * AutomationRules 2022-01-01-preview: Add constraints (#18099) * add contraints (alinged with the latest stable version) Co-authored-by: debroy <debjyoti.iitkgp@gmail.com> Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> Co-authored-by: RoeyBC <roey.benhaim@gmail.com> Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> Co-authored-by: Laith Hisham <49263932+laithhisham@users.noreply.github.com> Co-authored-by: ushasan <69323982+ushasan@users.noreply.github.com> Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> Co-authored-by: shschwar <55053268+shschwar@users.noreply.github.com> Co-authored-by: Usman Hasan <usman.hasan@microsoft.com> Co-authored-by: royrein <37300636+royrein@users.noreply.github.com> Co-authored-by: Roy Reinhorn <roreinho@microsoft.com> Co-authored-by: dosegal <51155368+dosegal@users.noreply.github.com> Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
* Adds base for updating Microsoft.SecurityInsights from version preview/2021-10-01-preview to version 2022-01-01-preview * Updates readme * Updates API version in new specs and examples * SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model (Azure#17849) * SourceControl 2022-01-01-preview version change * fix validation error * prettified * prettified Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> * New metadata API (Azure#17942) * metadata changes * addressed changes * updated enum kind * updated values as well Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> * added new enum to kind (Azure#17994) Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> * Add flag to rotate webhook secret (Azure#17989) Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> * Align definitions with stable version (Azure#17931) * Align definitions with stable version * align scheduled rule and template properties with stable * Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes (Azure#17848) * changed source to sourceType and watchlistAlias to alias * Update CreateWatchlistAndWatchlistItems.json * Update CreateWatchlistItem.json * Update DeleteWatchlist.json * Update DeleteWatchlistItem.json * Update GetWatchlistByAlias.json * Update GetWatchlistItemById.json * Update GetWatchlistItems.json * Update GetWatchlistByAlias.json * added missing params to match stable version * Revert "added missing params to match stable version" This reverts commit a30a709. Reverting by 1 commit * refreshing pipeline * reverting lint diff change * attempting to fix RemovedPath breaking changes * Revert "attempting to fix RemovedPath breaking changes" This reverts commit 2f96ee3. reverting attempt at correcting breaking changes. cannot match preview to stable without breaking everything. * adding back source type for backwards compatibility, added response descriptions, corrected PR comments * adding missing bracket * ran npm run prettier-fix to correct style issues * resolving model/definition errors * Revert "resolving model/definition errors" This reverts commit fd67a4f. Reverting prettier changes made to other branches * Revert "ran npm run prettier-fix to correct style issues" This reverts commit 3055791. * update * Update DeleteWatchlist.json * Update Watchlists.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * fixing styling issues on Delete example * Update DeleteWatchlist.json * Update DeleteWatchlist.json * ran npm run prettier on DeleteWatchlist.json * Update Watchlists.json * reverting alias to watchlistAlias Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> * Rename system to AutoAssigned (Azure#18061) * Rename system to AutoAssigned * Add example to list operations * Update API version in NRT examples * Execute validation tools and fix results (Azure#17733) * Execute validation tools and fic results * Prettyfieir GetIoTById.json * Watchlists.json-2022-01-01-preview-parameterNameChanges (reverted PR reference for files changed -> https://github.com/Azure/azure-rest-api-specs/pull/17848/files) (Azure#18085) * changed source to sourceType and watchlistAlias to alias * Update CreateWatchlistAndWatchlistItems.json * Update CreateWatchlistItem.json * Update DeleteWatchlist.json * Update DeleteWatchlistItem.json * Update GetWatchlistByAlias.json * Update GetWatchlistItemById.json * Update GetWatchlistItems.json * Update GetWatchlistByAlias.json * added missing params to match stable version * Revert "added missing params to match stable version" This reverts commit a30a709. Reverting by 1 commit * refreshing pipeline * reverting lint diff change * attempting to fix RemovedPath breaking changes * Revert "attempting to fix RemovedPath breaking changes" This reverts commit 2f96ee3. reverting attempt at correcting breaking changes. cannot match preview to stable without breaking everything. * adding back source type for backwards compatibility, added response descriptions, corrected PR comments * adding missing bracket * ran npm run prettier-fix to correct style issues * resolving model/definition errors * Revert "resolving model/definition errors" This reverts commit fd67a4f. Reverting prettier changes made to other branches * Revert "ran npm run prettier-fix to correct style issues" This reverts commit 3055791. * update * Update DeleteWatchlist.json * Update Watchlists.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * Update DeleteWatchlist.json * fixing styling issues on Delete example * Update DeleteWatchlist.json * Update DeleteWatchlist.json * ran npm run prettier on DeleteWatchlist.json * Update Watchlists.json * reverting alias to watchlistAlias * fixing type version * Update Watchlists.json * Update DeleteWatchlist.json * fixing commas Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> Co-authored-by: Usman Hasan <usman.hasan@microsoft.com> * Done (Azure#17843) Co-authored-by: Roy Reinhorn <roreinho@microsoft.com> * AutomationRules 2022-01-01-preview: Add constraints (Azure#18099) * add contraints (alinged with the latest stable version) Co-authored-by: debroy <debjyoti.iitkgp@gmail.com> Co-authored-by: debjyoti11 <debjyotiroy88@gmail.com> Co-authored-by: RoeyBC <roey.benhaim@gmail.com> Co-authored-by: Roey Ben Chaim <robencha@microsoft.com> Co-authored-by: Laith Hisham <49263932+laithhisham@users.noreply.github.com> Co-authored-by: ushasan <69323982+ushasan@users.noreply.github.com> Co-authored-by: Hassan Chawiche <hassanc@microsoft.com> Co-authored-by: shschwar <55053268+shschwar@users.noreply.github.com> Co-authored-by: Usman Hasan <usman.hasan@microsoft.com> Co-authored-by: royrein <37300636+royrein@users.noreply.github.com> Co-authored-by: Roy Reinhorn <roreinho@microsoft.com> Co-authored-by: dosegal <51155368+dosegal@users.noreply.github.com> Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.